Developer Guide

This guide is intended for three groups of developers

• those using the XMLRPC API

• those developing 3rd-party plugins

• developers hacking on the koji

• Basic Client
  • Multicalls
• Koji Profiles
  • Command Line Interface
  • Configuration Files
  • Using Koji Profiles in Python
    • Examples
• Writing Koji plugins
  • Adding new task types
  • Exporting new API methods over XMLRPC
    • Ensuring the user has the required permissions
  • Running code automatically triggered on events
  • List of callbacks
  • New command for CLI
  • Pull requests
• Koji Content Generators
  • Requirements for writing a Content Generator
    • Avoid Using the Host’s Software
    • Source of build environment content
    • Binaries (or other compiled content) from Upstream May Not become included in output
    • Log all Transformations of Content
    • Preserve All Inputs
    • Preserve All Outputs
    • Do Not Use Caching Mechanisms
  • Metadata
  • API
  • Current Public Implementations
• Koji Content Generator Metadata
  • Format
    • metadata_version
    • build
    • buildroots
    • output
  • Example Metadata JSON
• Writing Koji Code
  • Getting Started Hacking on Koji
  • Task Flow
  • Component Overview
    • Koji-client
      • Option Handling
      • Profiles
      • Creating Tasks
      • Task Arguments
      • Using multicall
    • Koji-Hub
      • Implementation Details
      • Database Interactions
      • Troubleshooting
    • Kojid
      • Implementation Details
        • TaskHandlers
        • Source Control Managers
        • Build Root Objects
      • Troubleshooting
    • Koji-Web
      • Troubleshooting
    • Kojira
  • Building and Deploying Changes
  • Writing Koji plugins
  • Submitting Changes
    • Partial work
  • Unit Tests
  • Further testing
  • Code Style
• Unit tests in Fedora’s Jenkins
  • Usage
  • Configuration
• Release process
  • Merging PRs
  • Release Notes
  • Pushing the Code
  • Updating the Site
  • Pushing to PyPi
  • Release Email
  • Required Permissions